ci(release): Switch from action-prepare-release to Craft #18763
Conversation
This PR migrates from the deprecated action-prepare-release to the new Craft GitHub Actions (reusable workflow or composite action). Changes: - Migrate .github/workflows/release.yml to Craft reusable workflow
BYK
force-pushed
the
ci/migrate-to-craft-action
branch
from
f89e6b1 to
b9ae430
Compare
Semver Impact of This PR🟢 Patch (bug fixes) 📋 Changelog PreviewThis is how your changes will appear in the changelog. New Features ✨
Build / dependencies / internal 🔧
🤖 This preview updates automatically when you update the PR. |
node-overhead report 🧳Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.
|
The previous migration incorrectly removed the GitHub App token authentication step. This commit restores it by switching to the composite action pattern which preserves the auth flow.
The previous migration incorrectly removed the GitHub App token authentication step. This commit restores it by switching to the composite action pattern which preserves the auth flow.
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
.github/workflows/auto-release.yml
Outdated
| on: | ||
| pull_request: | ||
| types: | ||
| - closed | ||
| branches: | ||
| - master | ||
|
|
||
| # This workflow tirggers a release when merging a branch with the pattern `prepare-release/VERSION` into master. | ||
| workflow_dispatch: | ||
| inputs: | ||
| version: | ||
| description: Version to release (or "auto") | ||
| required: false | ||
| force: | ||
| description: Force a release even when there are release-blockers |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
.github/workflows/auto-release.yml
Outdated
| on: | ||
| pull_request: | ||
| types: | ||
| - closed | ||
| branches: | ||
| - master | ||
| workflow_dispatch: | ||
| inputs: | ||
| version: | ||
| description: Version to release (or "auto") | ||
| required: false | ||
| force: | ||
| description: Force a release even when there are release-blockers | ||
| required: false | ||
| merge_target: |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
.github/workflows/release.yml
Outdated
| - name: Prepare release | ||
| uses: getsentry/craft@39ee616a6a58dc64797feecb145d66770492b66c # v2 | ||
| env: | ||
| GITHUB_TOKEN: ${{ steps.token.outputs.token }} | ||
| with: | ||
| version: ${{ inputs.version }} | ||
| force: ${{ inputs.force }} | ||
| merge_target: ${{ inputs.merge_target }} | ||
| craft_config_from_merge_target: 'true' |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
| node-version-file: 'package.json' | ||
| - name: Prepare release | ||
| uses: getsentry/action-prepare-release@v1 | ||
| uses: getsentry/craft@5d154a7facb096e38889be2c6caf2fd23649aa92# v2 |
There was a problem hiding this comment.
Missing space before comment makes ref invalid
High Severity
The uses value getsentry/craft@5d154a7facb096e38889be2c6caf2fd23649aa92# v2 is missing a space before #. In YAML, # only starts a comment when preceded by whitespace. Without the space, # v2 becomes part of the ref string, resulting in the invalid git ref 5d154a7facb096e38889be2c6caf2fd23649aa92# v2. This will cause the release workflow to fail every time. Compare with line 26 which correctly uses a space: ...f6c875baf # v2.2.1.
| with: | ||
| node-version-file: 'package.json' | ||
| - name: Prepare release | ||
| uses: getsentry/action-prepare-release@v1 | ||
| uses: getsentry/craft@5d154a7facb096e38889be2c6caf2fd23649aa92# v2 | ||
| env: | ||
| GITHUB_TOKEN: ${{ steps.token.outputs.token }} | ||
| with: |
There was a problem hiding this comment.
Bug: The auto-release.yml workflow was not migrated to the new Craft action and still uses the deprecated getsentry/action-prepare-release@v1, contrary to the PR's description.
Severity: HIGH
Suggested Fix
Update the .github/workflows/auto-release.yml file to use the new Craft reusable workflow, similar to the changes made in .github/workflows/release.yml. This will ensure both manual and automated release processes are consistent and no longer rely on the deprecated getsentry/action-prepare-release@v1 action.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: .github/workflows/release.yml#L36-L42
Potential issue: The pull request claims to migrate release workflows to the new Craft
action, but the `auto-release.yml` file was not updated. This file, which triggers an
automated release process when a `prepare-release/*` branch is merged, continues to use
the deprecated `getsentry/action-prepare-release@v1` action. This creates an
inconsistency with the manually triggered `release.yml` workflow, which was correctly
updated. The continued use of the deprecated action poses a risk of failure for the
automated release process if the action is removed or becomes unmaintained.
Did we get this right? 👍 / 👎 to inform future reviews.
Codecov Results 📊Generated by Codecov Action |
2 participants
Summary
This PR migrates from the deprecated
action-prepare-releaseto the new Craft GitHub Actions.Changes
.github/workflows/auto-release.ymlto Craft reusable workflowDocumentation
See https://getsentry.github.io/craft/github-actions/ for more information.
Closes #18765 (added automatically)